
		<HTML>
		<HEAD>
		<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
		<meta name="description" content="Flash MX 2004 ActionScript2.0 Library: Box - Wright Internet Solutions">
		<meta name="keywords" content="geometry,polytope,Box,Flash,MX,2004,ActionScript,ActionScript2.0,AS2.0 Library,AS2,AS2 Library,Wright Internet Solutions,Wright,class,documentation,methods,functions,interfaces,JavaScript,Java">
		<TITLE>WIS AS2 Library : com.wis.math.geom.polytope.Box Documentation</TITLE>

		<STYLE><!--
		HR.small{height:1px; width:100%; background:#E7BFA3; border: 0px;}
		HR.big{height:4px; width:100%; background:#E7BFA3; border: 0px;}
		A:hover{text-decoration: underline}
		A{text-decoration: none; color: #993333}
		code{font-family: monospace; font-size: 12px; color: #666666;}
		.methodAttributesTitle{font-size: 12px; font-weight: bold; color: #7B779C}
		.ToC{font-size: 12px; font-weight: bold; color: #993333}
		.methodTitle{font-size: 14px; font-weight: bold; color: #993333}
		.groupTitle{font-size: 18px; font-weight: bold; color: #993333}
		.sectionTitle{font-size: 22px; font-weight: bold; color: #993333}
		.majorTitle{font-size: 32px; font-weight: bold; color: #993333; padding-bottom:100px;}
		.methodsDiv{margin-left:40px;}
		.footer{font-size: 11px; color: #666666;}
		body{font-family: arial,sans-serif; font-size: 12px;}
		//--></STYLE>

		</HEAD>
		<BODY bgColor='#ffffcc'>
		<P class='majorTitle'>com.wis.math.geom.polytope.Box Documentation</P>


		<P><B>Author:</B> <a href='mailto:wisolutions2002@shaw.ca?subject=wisASLibrary Box Class'>Richard Wright</a><BR>
		<B>Last Modified:</B> 08/03/04 00:57:07<HR class='big'>

		<P class='sectionTitle'>Summary</P>
		<P class='ToC'>com.wis.math.geom.polytope.Box class:</P>
		<div class='methodsDiv'><a href='#classinfo'>- description</a></div>
<P class='ToC'>com.wis.math.geom.polytope.Box Properties:</P><div class='methodsDiv'>
<a href='#$v1'>- $v1</a><br>
<a href='#$v2'>- $v2</a><br>
<a href='#$dimsInv'>- $dimsInv</a><br>
<a href='#$negV1'>- $negV1</a><br>
<a href='#$boundedBy'>- $boundedBy</a><br>
</div><br>
<P class='ToC'>com.wis.math.geom.polytope.Box Methods:</P><div class='methodsDiv'>
<a href='# copy'>-  copy</a><br>
<a href='# initialize'>-  initialize</a><br>
<a href='# findIntersectionsUntransformed'>-  findIntersectionsUntransformed</a><br>
<a href='# isPointInsideUntransformed'>-  isPointInsideUntransformed</a><br>
<a href='# getNormalAtUntransformed'>-  getNormalAtUntransformed</a><br>
<a href='# init'>-  init</a><br>
<a href='# findInts'>-  findInts</a><br>
</div><br>

		<HR class='big'>
		<P class='sectionTitle'><A name='classinfo'></A>com.wis.math.geom.polytope.Box <I>class</I></P>
		<P> <span class='methodTitle'>version:</span> 1.7</P>
		<P class="methodTitle">description:</P>
		<P>Implements the behaviours of the Box Class.
 <p>
 		        Provides methods for the IObj interface based on JS RayTracer2 by
 John Haggerty.
 </P>
		<P class="methodTitle">usage:</P> <pre>var inst:Box = new Box(v1,v2,isBound);</pre>

<P> <span class='methodTitle'>parameters:</span>
				<ul>
<li>      v1 (Vector)  -- a position Vector object defining one corner of the box.</li>
<li>      v2 (Vector)  -- a position Vector object defining the opposite corner of the box.</li>
<li>      isBound (Boolean)  -- if 'true', leaves dimensions as is, else inverses dimensions.</li>
</ul>

			<HR class='small'>
			<P class='groupTitle'><A name='properties'></A>com.wis.math.geom.polytope.Box Properties:</P>
			<div class='methodsDiv' >


				<P class='methodTitle'><A name='$v1'></A><u> $v1</u></P>
				<P> (Vector)  -- a position Vector object defining one corner of the box.</P>

				<P class='methodTitle'><A name='$v2'></A><u> $v2</u></P>
				<P> (Vector)  -- a position Vector object defining the opposite corner of the box.</P>

				<P class='methodTitle'><A name='$dimsInv'></A><u> $dimsInv</u></P>
				<P> (Vector)  -- if 'isBound' is 'true', an identity Vector object, else adds $v2 to the inverse of the negative of $v1.</P>

				<P class='methodTitle'><A name='$negV1'></A><u> $negV1</u></P>
				<P> (Vector)  -- a position Vector object defining negative of $v1.</P>

				<P class='methodTitle'><A name='$boundedBy'></A><u> $boundedBy</u></P>
				<P> (Box)  -- a bounding box object.</P>
</div>

			<HR class='small'>
			<P class='groupTitle'><A name='methods'></A>com.wis.math.geom.polytope.Box Methods:</P>
			<div class='methodsDiv' >


				<P class='methodTitle'><A name=' copy'></A><u>  copy</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Copies super's properties with its 'copyModifiers' method.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.copy();</pre>
     </P>
<P><span class='methodAttributesTitle'>returns:</span> (Obj)  -- returns a new Sphere object populated with super's properties.
    </P>

				<P class='methodTitle'><A name=' initialize'></A><u>  initialize</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Initializes this instance's bounding box and its super's low-level properties,
     and defines $negV1 property.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.initialize();</pre>
     </P>
<P><span class='methodAttributesTitle'>returns:</span> (Void)
    </P>

				<P class='methodTitle'><A name=' findIntersectionsUntransformed'></A><u>  findIntersectionsUntransformed</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Calculates enter and exit intersections, if any, defined by 'ray' tracer.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.findIntersectionsUntransformed(ray);</pre>
     </P>
<P> <span class='methodAttributesTitle'>parameters:</span><ul>
<li>  ray   (Ray)  -- tracer object that defines its point and direction in 3-space.</li>
</ul></P>
<P><span class='methodAttributesTitle'>returns:</span> (Array)  -- returns a list of Intersection objects, or an empty list.
    </P>

				<P class='methodTitle'><A name=' isPointInsideUntransformed'></A><u>  isPointInsideUntransformed</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Tests whether passed 'pos' Vector object is inside this instance.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.isPointInsideUntransformed(pos);</pre>
     </P>
<P> <span class='methodAttributesTitle'>parameters:</span><ul>
<li>  pos   (Vector)  -- a position Vector object.</li>
</ul></P>
<P><span class='methodAttributesTitle'>returns:</span> (Boolean)
    </P>

				<P class='methodTitle'><A name=' getNormalAtUntransformed'></A><u>  getNormalAtUntransformed</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Defines the normal to the passed 'pos' Vector object.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.getNormalAtUntransformed(pos);</pre>
     </P>
<P> <span class='methodAttributesTitle'>parameters:</span><ul>
<li>  pos   (Vector)  -- a position Vector object.</li>
</ul></P>
<P><span class='methodAttributesTitle'>returns:</span> (Vector)  -- returns normal of untransformed vector.
    </P>

				<P class='methodTitle'><A name=' init'></A><u>  init</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Initializes class instance properties beyond its super's properties.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.init(v1,v2,isBound);</pre>
     </P>
<P> <span class='methodAttributesTitle'>parameters:</span><ul>
<li>  v1   (Vector)  -- a direction Vector object.</li>
<li>  v2   (Vector)  -- a direction Vector object.</li>
<li>  isBound   (Boolean)  -- if 'true', leaves dimensions as is, else inverses dimensions.</li>
</ul></P>
<P><span class='methodAttributesTitle'>returns:</span> (Void)
    </P>

				<P class='methodTitle'><A name=' findInts'></A><u>  findInts</u></P>
				<P><span class='methodAttributesTitle'>description: </span>
				Defines all six intersections of the box.
     </P>
				<P><span class='methodAttributesTitle'>usage:</span> <pre>inst.findInts(ints,v1,v2,dim,odim1,odim2,s,d);</pre>
     </P>
<P> <span class='methodAttributesTitle'>parameters:</span><ul>
<li>  ints   (Array)  -- a holder for Intersection objects.</li>
<li>  v1   (Vector)  -- a direction Vector object.</li>
<li>  v2   (Vector)  -- a direction Vector object.</li>
<li>  dim   (String)  -- ths string 'x'.</li>
<li>  odim1   (String)  -- ths string 'y'.</li>
<li>  odim2   (String)  -- ths string 'z'.</li>
<li>  s   (Vector)  -- ray start Vector object.</li>
<li>  d   (Vector)  -- ray direction Vector object.</li>
</ul></P>
<P><span class='methodAttributesTitle'>returns:</span> (Void)
    </P>
</div>

			<BR>
			<BR>
			<HR class='big'>
			<span class="footer">generated with <A href='http://blog.klaustrofobik.org/' target='_blank'>AS2docGenerator beta 0.5.3</A></span>
			</BODY>
			</HTML>

